Linter Bot Results:

Hi @MohitKumar020291! Thanks for making this PR. We linted your code and found the following:

Some issues were found with the formatting of your code.

Please have a look at the darker-main-code and darker-test-code steps here for more details: https://github.com/MDAnalysis/mdanalysis/actions/runs/5441610741/jobs/9895771696

Please note: The black linter is purely informational, you can safely ignore these outcomes if there are no flake8 failures!

Codecov Report

Patch coverage has no change and project coverage change: -0.30 ⚠️

Comparison is base (6532f7b) 93.61% compared to head (85b78ec) 93.32%.

@@             Coverage Diff             @@
##           develop    #4182      +/-   ##
===========================================
- Coverage    93.61%   93.32%   -0.30%     
===========================================
  Files          193      193              
  Lines        25170    25170              
  Branches      4059     4059              
===========================================
- Hits         23562    23489      -73     
- Misses        1092     1158      +66     
- Partials       516      523       +7     

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

The AUTHORS file is package/AUTHORS.

The error that you encounter may be due to not having installed MDAnalysis.

I suggest you follow the instructions in the user guide to create a development environment with conda https://userguide.mdanalysis.org/stable/contributing_code.html#creating-a-development-environment and then install a development version with pip install -e ./package.

If it still fails, describe step by step what you did. (Copy and paste code into the issue, that’s better than images; if only images are possible then you can directly drop them here, too)

@orbeckst thanks for review. I tried multiple ways of creating universe but doctests failed. I am attaching the screenshots, please help to solve them.
https://i.imgur.com/xCEdQbE.png
https://i.imgur.com/XRbeVKl.png

@MohitKumar020291 the second screenshot corresponds to the issue outlined by @orbeckst. In the first screenshot I think the issue is that you are using TPR and TRR within strings, while they should be passed directly.

Thanks @RMeli for review. I tried passing TRR and TPR directly. But the results are not desirable. Screenshot attached.
https://i.imgur.com/U064e9k.png
EDIT: Please ignore, it is fixed now.

@RMeli and @orbeckst. I have made some latest change. I imported align as to use rotation_matrix. Secondly, I skipped one line because it was causing wrong output, Attached screenshots:

RELATED TO ABOVE IMAGE

After doing these changes I am not getting Failed test(like FAILED analysis\align.py::MDAnalysis.analysis.align.rotation_matrix ), Screenshot attached(THIS IMAGE DOES NOT HAVE Failing align.rotation_matrix as of SECOND IMAGE ):

This solves one out of two problems of align.py.

This solves one out of two problems of align.py.

Great that you identified another problem in the same file. It would be great if all tests in align.py were to pass — please, feel free to also fix this in the same PR here! It looks as if it's just a missing closing parenthesis.

=================================== FAILURES ===================================
_____________________ [doctest] MDAnalysis.analysis.align ______________________
083 mass (or geometry) first:
084
085    >>> rmsd(mobile.select_atoms('name CA').positions, ref.select_atoms('name CA').positions, center=True)
086    21.892591663632704
087
088 This has only done a translational superposition. If you want to also do a
089 rotational superposition use the superposition keyword. This will calculate a
090 minimized RMSD between the reference and mobile structure.
091
092    >>> rmsd(mobile.select_atoms('name CA').positions, ref.select_atoms('name CA').positions,
UNEXPECTED EXCEPTION: SyntaxError("'(' was never closed", ('<doctest MDAnalysis.analysis.align[8]>', 1, 5, "rmsd(mobile.select_atoms('name CA').positions, ref.select_atoms('name CA').positions,\n", 1, 0))
Traceback (most recent call last):
  File "~/anaconda3/envs/mda310dev/lib/python3.10/doctest.py", line 1348, in __run
    exec(compile(example.source, filename, "single",
  File "<doctest MDAnalysis.analysis.align[8]>", line 1
    rmsd(mobile.select_atoms('name CA').positions, ref.select_atoms('name CA').positions,

SyntaxError: '(' was never closed

I had a quick look at align.py: there are a few more errors. The "missing parenthesis" is only the first one (and it's not really a missing parenthesis, just an incorrect line continuation).

If you want to, you can quickly work through all of them and make this a very nice PR:

1. First run the doc test

   pytest -v --disable-pytest-warnings --doctest-modules package/MDAnalysis/analysis/align.py

   just on the file.
2. Then read the error message.
3. Fix the line.
4. Repeat with 1

At the end there's an example that uses the clustalw program: just skip all of it with

   >>> seldict = align.fasta2select('sequences.aln')                                # doctest:+SKIP
   >>> alignment = align.AlignTraj(trj, ref, filename='rmsfit.dcd', select=seldict) # doctest:+SKIP
   >>> alignment.run()                                                              # doctest:+SKIP

as this example is difficult to run under all circumstances (because clustalw is not always installed) and we don't have all input files at hand.

@orbeckst and @RMeli. I have again updated align.py and these changes helped to Pass both failures of align.py.
Screenshot attached:

Please review.

Please also add yourself to AUTHORS and introduce yourself on the mailing list (see my previous review comments) — we won't merge a new contribution without the authorship/email information.

I tried finding "how to add myself to changelog and author?", but did not found helpful results. So, I tried copying format in AUTHOR but I can't see 2023 in package/AUTHORS, so, I created my one(2023) which is obviously causing errors. Any solution to it?

I am trying to understand why it's difficult for you to find the AUTHORS file. How do you edit the files that you are changing?

I am trying to understand why it's difficult for you to find the AUTHORS file. How do you edit the files that you are changing?

@orbeckst I can find the AUTHORS file but not 2023 it has only 2022. I was trying to change it through edit(it is a bad practice) but it is also not showing in my VS code(on both develop and 3365 branch).

Apart from that I have resolved the latest changes.
Thanks for review

@MohitKumar020291 you might have an older version of the repository and the errors you see are conflicts?

@RMeli I have latest version even then I will check it again. Yes, they were conflicts.

THanks for introducing yourself on the developer list.

The current AUTHORS file is on your branch: I can see it in the web interface https://github.com/MohitKumar020291/mdanalysis/blob/3365/package/AUTHORS. Maybe you have to git pull your local branch in order to update it? If there are merge conflicts then you have to fix them.

EDIT: The AUTHORS addition is the only thing that's missing before we can approve the PR and squash-merge.

@orbeckst I have successfully updated AUTHORS file. Thanks.

@orbeckst changes done. Thanks.

@orbeckst I tried finding issues multiple times with formatting but I did not get anything.

I'd recommend that you

1. build the docs locally
2. check if it fails
3. fix file/try out things
4. goto 1 (until no errors)
5. commit & push
6. check CI

instead of having to wait for a while until the CI on GitHub runs.

To build the docs locally have a look at our User Guide: Building docs. You will need to set up a development environment in which you can build docs. Follow User Guide: Create a virtual environment (I would use conda/mamba). Unfortunately, the docs are a bit outdated. MDAnalysis/UserGuide#260 contains some instructions to be added to an updated User Guide version. In short, try in your conda environment (with python>=3.8):

# packages for MDAnalysis
conda install -c bioconda -c conda-forge \
            biopython chemfiles clustalw==2.1 codecov cython \
            griddataformats gsd hypothesis "joblib>=0.12" \
            matplotlib mmtf-python mock netcdf4 networkx \
            "numpy>=1.18.0" psutil pytest scikit-learn scipy \
            "seaborn>=0.7.0" "tidynamics>=1.0.0" \
            "tqdm>=4.43.0"

# documentation dependencies
conda install -c conda-forge sphinx pybtex pybtex-docutils \
	   sphinxcontrib-bibtex sphinx_rtd_theme sphinx-sitemap
python -m pip install msmb_theme==1.2.0

Then you should be able to build the docs as described, in short

cd package
python setup.py build_sphinx -E

Look at the output to see where files are generated. Read the output for errors.

@orbeckst I think I have fixed the issue build docs, this is failing because of code coverage. Can you please rerun the checks?

Well done! Thank you for your contribution!

@orbeckst and @RMeli, Thanks to both for reviews and great guidance.